Skip to content

QtFRED help dialog and documentation#7380

Open
MjnMixael wants to merge 15 commits intoscp-fs2open:masterfrom
MjnMixael:qtfred-help-dialog-docs
Open

QtFRED help dialog and documentation#7380
MjnMixael wants to merge 15 commits intoscp-fs2open:masterfrom
MjnMixael:qtfred-help-dialog-docs

Conversation

@MjnMixael
Copy link
Copy Markdown
Contributor

Adds the help dialog and written documentation. The actual code changes here are pretty minimal and most of the PR is the written documentation for each dialog. This uses Qt's help system which requires Qt's QSLite SQL driver which this adds to the build workflows. I'm inexperienced with CMAKE but I've got this working such that building QtFRED will compile the help file and copy it next to the exe.

The help system I've setup here is one where SCP will take ownership of keeping the dialog documentation up to date. Any time features are added/changed/removed from a dialog, the associated help html file should also be updated. Additionally, the help dialog will search in data/freddocs for loose html files and add them to the Tutorials tab. This is intended to provide mods like FOTG a way to inject mod-specific documentation directly into the help window. These html files will obey the dark/light theme, be searchable, and can link directly internal dialog documentation. An example html file has been included with this PR.

An overwhelming majority of the lines/files changed here is the actual documentation files. Some of them, like sexps, are placeholder. I've asked naomi to help write more complete versions because she is an experienced tutor.

@MjnMixael MjnMixael added the qtfred A feature or issue related to qtFred. label Apr 16, 2026
@github-project-automation github-project-automation Bot moved this to Work In Progress (PRs) in qtFRED2 Apr 16, 2026
@MjnMixael MjnMixael force-pushed the qtfred-help-dialog-docs branch 3 times, most recently from adf6c15 to da5dc2e Compare April 23, 2026 15:26
@MjnMixael MjnMixael force-pushed the qtfred-help-dialog-docs branch from f91a5ad to c153e02 Compare April 24, 2026 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

qtfred A feature or issue related to qtFred.

Projects

Status: Work In Progress (PRs)

Development

Successfully merging this pull request may close these issues.

1 participant